Class TBaseCellAreas

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type TBaseCellAreas = class(TObjectList)

Description

Virtual base class for objects that manipulates cell areas.

Hierarchy

  • TObjectList
  • TBaseCellAreas

Overview

Methods

Public constructor Create;
Public procedure Assign(Areas: TBaseCellAreas);
Public function Add: TCellArea; overload;
Public function Add(const ARef: AxUCString): TCellArea; overload;
Public function Add(const AArea: PXLSCellArea): TCellArea; overload;
Public function Add(const C,R: integer): TCellArea; overload;
Public function Add(const C1,R1,C2,R2: integer): TCellArea; overload;
Public procedure Add(const C1,R1,C2,R2: integer; AAreas: TBaseCellAreas); overload;
Public function CellCount: integer;
Public function TotExtent: TXLSCellArea;
Public procedure NormalizeAll;
Public function AreaInAreas(AArea: TCellArea): boolean; overload;
Public function AreaInAreas(const Col1,Row1,Col2,Row2: integer): boolean; overload;
Public function FindArea(const Col1,Row1,Col2,Row2: integer): integer; overload;
Public function FindArea(const Col,Row: integer): integer; overload;
Public function CellInAreas(const Col,Row: integer): integer;
Public procedure Copy(const Col1,Row1,Col2,Row2: integer; const DeltaCol,DeltaRow: integer); virtual;
Public procedure Delete(const Col1,Row1,Col2,Row2: integer); overload; virtual; abstract;
Public function Include(const Col1,Row1,Col2,Row2: integer): TCellArea; virtual; abstract;
Public procedure Move(const DeltaCol,DeltaRow: integer); overload; virtual; abstract;
Public procedure Move(const Col1,Row1,Col2,Row2: integer; const DeltaCol,DeltaRow: integer); overload; virtual; abstract;

Properties

Public property Items[constIndex:integer]: TCellArea read GetItems;
Public property Delimiter: AxUCChar read FDelimiter;
Public property DelimitedText: AxUCString read GetDelimitedText write SetDelimitedText;
Public property Tag: integer read FTag write FTag;

Description

Methods

Public constructor Create;

˜exclude

Public procedure Assign(Areas: TBaseCellAreas);

Assigns a TBaseCellAreas to this areas.

Public function Add: TCellArea; overload;

Add a new cell area. ˜result The added area.

Public function Add(const ARef: AxUCString): TCellArea; overload;

Add a new cell area. ˜param C1 Left column. ˜param R1 Top row. ˜param C2 Right column. ˜param R2 Bottom row. ˜result The added area.

Public function Add(const AArea: PXLSCellArea): TCellArea; overload;
 
Public function Add(const C,R: integer): TCellArea; overload;
 
Public function Add(const C1,R1,C2,R2: integer): TCellArea; overload;
 
Public procedure Add(const C1,R1,C2,R2: integer; AAreas: TBaseCellAreas); overload;
 
Public function CellCount: integer;
 
Public function TotExtent: TXLSCellArea;

Returns the smallest area that all areas in the list fits in. ˜result The area.

Public procedure NormalizeAll;

Normalizes (i.e. checks that C1 < C2 and R1 < R2).

Public function AreaInAreas(AArea: TCellArea): boolean; overload;

Checks if an area intersects any of the areas. ˜param Col1 Left column. ˜param Row1 Top row. ˜param Col2 Right column. ˜param Row2 Bottom row. ˜result True if the area given by Col1,Row1,Col2,Row2 intersects any of the areas in the list.

Public function AreaInAreas(const Col1,Row1,Col2,Row2: integer): boolean; overload;
 
Public function FindArea(const Col1,Row1,Col2,Row2: integer): integer; overload;

Searches for an area that is equal to Col1,Row1,Col2,Row2. If a area is found, the index to the area is returned. If not found, -1 is returned. ˜param Col1 Left column. ˜param Row1 Top row. ˜param Col2 Right column. ˜param Row2 Bottom row. ˜result The index of the found area. If not found, -1 is returned.

Public function FindArea(const Col,Row: integer): integer; overload;
 
Public function CellInAreas(const Col,Row: integer): integer;

Check if a cell is in any of the areas. Returns the index of the area that the cell address given by Col and Row is within. If no match is found, -1 is returned. ˜param Col Column of the cell. ˜param Row Row of the cell. ˜result The index of the found area. If not found, -1 is returned.

Public procedure Copy(const Col1,Row1,Col2,Row2: integer; const DeltaCol,DeltaRow: integer); virtual;

˜exclude

Public procedure Delete(const Col1,Row1,Col2,Row2: integer); overload; virtual; abstract;

˜exclude

Public function Include(const Col1,Row1,Col2,Row2: integer): TCellArea; virtual; abstract;

˜exclude

Public procedure Move(const DeltaCol,DeltaRow: integer); overload; virtual; abstract;

˜exclude

Public procedure Move(const Col1,Row1,Col2,Row2: integer; const DeltaCol,DeltaRow: integer); overload; virtual; abstract;

˜exclude

Properties

Public property Items[constIndex:integer]: TCellArea read GetItems;

The areas in the list.

Public property Delimiter: AxUCChar read FDelimiter;
 
Public property DelimitedText: AxUCString read GetDelimitedText write SetDelimitedText;
 
Public property Tag: integer read FTag write FTag;
 

Generated by PasDoc 0.12.1 on 2013-03-18 12:36:47